<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/map/ordered_map.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ordered__map_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ordered_map.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The ordered map.  
<a href="#details">More...</a></p>

<p><a href="ordered__map_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOrderedMap.html">OrderedMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The implementation for ordered map.  <a href="structOrderedMap.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9f4a5f5b5f37e63daa432caf3dde3dbd"><td class="memItemLeft" align="right" valign="top">typedef struct _OMapData&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">OMapData</a></td></tr>
<tr class="memdesc:a9f4a5f5b5f37e63daa432caf3dde3dbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">OMapData is the data type for the container private information.  <a href="#a9f4a5f5b5f37e63daa432caf3dde3dbd">More...</a><br/></td></tr>
<tr class="separator:a9f4a5f5b5f37e63daa432caf3dde3dbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac1581cadbe1e602e3041c761b643422b"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#ac1581cadbe1e602e3041c761b643422b">OdrMapInit</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> **ppObj)</td></tr>
<tr class="memdesc:ac1581cadbe1e602e3041c761b643422b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constructor for <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a>.  <a href="#ac1581cadbe1e602e3041c761b643422b">More...</a><br/></td></tr>
<tr class="separator:ac1581cadbe1e602e3041c761b643422b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5639a5fd98e433881893d6e72c6c1fd8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a5639a5fd98e433881893d6e72c6c1fd8">OdrMapDeinit</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> **ppObj, bool bClean)</td></tr>
<tr class="memdesc:a5639a5fd98e433881893d6e72c6c1fd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The destructor for <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a>.  <a href="#a5639a5fd98e433881893d6e72c6c1fd8">More...</a><br/></td></tr>
<tr class="separator:a5639a5fd98e433881893d6e72c6c1fd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2963c0b274b18502cc18921831aec53a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a2963c0b274b18502cc18921831aec53a">OdrMapPut</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self, <a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a> ent, bool bClean)</td></tr>
<tr class="memdesc:a2963c0b274b18502cc18921831aec53a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a key value pair into the map.  <a href="#a2963c0b274b18502cc18921831aec53a">More...</a><br/></td></tr>
<tr class="separator:a2963c0b274b18502cc18921831aec53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a619a60d853dd6688a982e83e443814e1"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a619a60d853dd6688a982e83e443814e1">OdrMapGet</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self, <a class="el" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a> key, <a class="el" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a> *pValue)</td></tr>
<tr class="memdesc:a619a60d853dd6688a982e83e443814e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the value corresponding to the designated key.  <a href="#a619a60d853dd6688a982e83e443814e1">More...</a><br/></td></tr>
<tr class="separator:a619a60d853dd6688a982e83e443814e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd56c8934746ba953f44f288883c3969"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#abd56c8934746ba953f44f288883c3969">OdrMapRemove</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self, <a class="el" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a> key, bool bClean)</td></tr>
<tr class="memdesc:abd56c8934746ba953f44f288883c3969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the key value pair corresponding to the designated key.  <a href="#abd56c8934746ba953f44f288883c3969">More...</a><br/></td></tr>
<tr class="separator:abd56c8934746ba953f44f288883c3969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a9125dcdae60f2c676b2240b20a0e66"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a9a9125dcdae60f2c676b2240b20a0e66">OdrMapSize</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self)</td></tr>
<tr class="memdesc:a9a9125dcdae60f2c676b2240b20a0e66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of stored key value pairs.  <a href="#a9a9125dcdae60f2c676b2240b20a0e66">More...</a><br/></td></tr>
<tr class="separator:a9a9125dcdae60f2c676b2240b20a0e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1221dca5f047d70e2279760378402418"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#a1221dca5f047d70e2279760378402418">OdrMapSetCompare</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self, int32_t(*pFunc)(<a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>, <a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>))</td></tr>
<tr class="memdesc:a1221dca5f047d70e2279760378402418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the user defined key value pair comparison method.  <a href="#a1221dca5f047d70e2279760378402418">More...</a><br/></td></tr>
<tr class="separator:a1221dca5f047d70e2279760378402418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe4c866e17b74263cea428ea554b984f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ordered__map_8h.html#abe4c866e17b74263cea428ea554b984f">OdrMapSetDestroy</a> (<a class="el" href="structOrderedMap.html">OrderedMap</a> *self, void(*pFunc)(<a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>))</td></tr>
<tr class="memdesc:abe4c866e17b74263cea428ea554b984f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the user defined key value pair clean method.  <a href="#abe4c866e17b74263cea428ea554b984f">More...</a><br/></td></tr>
<tr class="separator:abe4c866e17b74263cea428ea554b984f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The ordered map. </p>

<p>Definition in file <a class="el" href="ordered__map_8h_source.html">ordered_map.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a9f4a5f5b5f37e63daa432caf3dde3dbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct _OMapData <a class="el" href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">OMapData</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>OMapData is the data type for the container private information. </p>

<p>Definition at line <a class="el" href="ordered__map_8h_source.html#l00011">11</a> of file <a class="el" href="ordered__map_8h_source.html">ordered_map.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac1581cadbe1e602e3041c761b643422b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> **&#160;</td>
          <td class="paramname"><em>ppObj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The constructor for <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppObj</td><td>The double pointer to the to be constructed map</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOMEM</td><td>Insufficient memory for map construction </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5639a5fd98e433881893d6e72c6c1fd8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OdrMapDeinit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> **&#160;</td>
          <td class="paramname"><em>ppObj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bClean</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The destructor for <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a>. </p>
<p>If the knob is on, it also runs the resource clean method for all the items.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ppObj</td><td>The double pointer to the to be destructed map </td></tr>
    <tr><td class="paramname">bClean</td><td>The knob to clean item resource </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a2963c0b274b18502cc18921831aec53a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapPut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>&#160;</td>
          <td class="paramname"><em>ent</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bClean</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Insert a key value pair into the map. </p>
<p>This function inserts a key value pair into the map. If the order of the designated pair is the same with a certain one stored in the map, that pair will be replaced. Also, if the knob is on, it runs the resource clean method for the replaced pair.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure </td></tr>
    <tr><td class="paramname">ent</td><td>The pointer to the desiganted key value pair </td></tr>
    <tr><td class="paramname">bClean</td><td>The knob to clean item resource</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
    <tr><td class="paramname">ERR_NOMEM</td><td>Insufficient memory for map extension </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a619a60d853dd6688a982e83e443814e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapGet </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a>&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a> *&#160;</td>
          <td class="paramname"><em>pValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the value corresponding to the designated key. </p>
<p>This function retrieves the value corresponding to the designated key from the map. If the key can be found, the value will be returned by the third parameter. Otherwise, the error code in returned and the third parameter is updated with NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure </td></tr>
    <tr><td class="paramname">key</td><td>The designated key </td></tr>
    <tr><td class="paramname">pValue</td><td>The pointer to the returned value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
    <tr><td class="paramname">ERR_NODATA</td><td>No map entry can be found </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abd56c8934746ba953f44f288883c3969"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapRemove </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a>&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bClean</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Delete the key value pair corresponding to the designated key. </p>
<p>This function deletes the key value pair corresponding to the designated key. If the knob is on, it also runs the resource clean method for the deleted pair.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure </td></tr>
    <tr><td class="paramname">key</td><td>The designated key </td></tr>
    <tr><td class="paramname">bClean</td><td>The knob to clean item resource</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
    <tr><td class="paramname">ERR_NODATA</td><td>No map entry can be found </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9a9125dcdae60f2c676b2240b20a0e66"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the number of stored key value pairs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of stored pairs </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1221dca5f047d70e2279760378402418"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapSetCompare </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t(*)(<a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>, <a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>)&#160;</td>
          <td class="paramname"><em>pFunc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the user defined key value pair comparison method. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure </td></tr>
    <tr><td class="paramname">pFunc</td><td>The function pointer to the custom method</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abe4c866e17b74263cea428ea554b984f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t OdrMapSetDestroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOrderedMap.html">OrderedMap</a> *&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void(*)(<a class="el" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>)&#160;</td>
          <td class="paramname"><em>pFunc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the user defined key value pair clean method. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">self</td><td>The pointer to <a class="el" href="structOrderedMap.html" title="The implementation for ordered map. ">OrderedMap</a> structure </td></tr>
    <tr><td class="paramname">pFunc</td><td>The function pointer to the custom method</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">SUCC</td><td></td></tr>
    <tr><td class="paramname">ERR_NOINIT</td><td>Uninitialized container </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1e899e21dcf63412585e33a90ca7eaf3.html">map</a></li><li class="navelem"><a class="el" href="ordered__map_8h.html">ordered_map.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
